Welcome to remotemanager’s documentation!

remotemanager is a flexible and modular package dedicated to facilitating running python functions on remote systems.

This documentation will cover the functionality and utilities that are made available by this package. You may also wish to browse the source code, which can be found here.

See the introduction page covering the very basics:

Introduction

• Intro to remotemanager
• Quickstart
• FAQ

Or see the tutorials for usage help:

Main Tutorials

• Dataset Usage
• Run Args
• Database and Backup
• Failed Runs
• Sending and Receiving Files

HPC Interfacing

• Submitting to a Scheduler
• Talking to the Scheduler
• Parameterising Jobscripts
• Dynamic Templates
• Advanced Connection Parameters
• Remote Commands

Advanced Tutorials

• Chaining Datasets
• Jupyter Magic
• Decorators
• Serialising Complex Objects
• Script Datasets

Misc Tutorials

• Dataset Cleaning
• Transport Usage
• Advanced logging techniques
• Verbose levels
• The Flags Module
• Function Tools
• Changing the Transport

Interoperability

• JUBE Interoperability

The following page contains a compilation of patch notes:

Version History

• Version History

Legacy Tutorials

• Creating a “True” Computer
• Updating a Computer
• Deeper Customisation with Parser
• Storing and Serialising Computers

See the generated API docs for specific queries and advanced usage:

API Documentation

• remotemanager
  • remotemanager package
    • Subpackages
      • remotemanager.JUBEInterop package
      • remotemanager.connection package
      • remotemanager.dataset package
      • remotemanager.decorators package
      • remotemanager.logging_utils package
      • remotemanager.script package
      • remotemanager.serialisation package
      • remotemanager.storage package
      • remotemanager.transport package
      • remotemanager.utils package

Indices and tables

• Index

• Search Page